* @Short_description: Displays a calendar and allows the user to select a date
* @Title: GtkCalendar
*
- * #GtkCalendar is a widget that displays a Gregorian calendar, one month
- * at a time. It can be created with gtk_calendar_new().
+ * `GtkCalendar` is a widget that displays a Gregorian calendar, one month
+ * at a time.
+ *
+ * 
+ *
+ * A `GtkCalendar` can be created with [ctor@Gtk.Calendar.new].
*
* The date that is currently displayed can be altered with
- * gtk_calendar_select_day().
+ * [method@Gtk.Calendar.select_day].
*
- * To place a visual marker on a particular day, use gtk_calendar_mark_day()
- * and to remove the marker, gtk_calendar_unmark_day(). Alternative, all
- * marks can be cleared with gtk_calendar_clear_marks().
+ * To place a visual marker on a particular day, use
+ * [method@Gtk.Calendar.mark_day] and to remove the marker,
+ * [method@Gtk.Calendar.unmark_day]. Alternative, all
+ * marks can be cleared with [method@Gtk.Calendar.clear_marks].
*
- * The selected date can be retrieved from a #GtkCalendar using
- * gtk_calendar_get_date().
+ * The selected date can be retrieved from a `GtkCalendar` using
+ * [method@Gtk.Calendar.get_date].
*
* Users should be aware that, although the Gregorian calendar is the
* legal calendar in most countries, it was adopted progressively
* ╰── label[.day-name][.week-number][.day-number][.other-month][.today]
* ]|
*
- * GtkCalendar has a main node with name calendar. It contains a subnode called header
- * containing the widgets for switching between years and months.
+ * `GtkCalendar` has a main node with name calendar. It contains a subnode
+ * called header containing the widgets for switching between years and months.
*
- * The grid subnode contains all day labels, including week numbers on the left (marked
- * with the .week-number css class) and day names on top (marked with the .day-name
- * css class).
+ * The grid subnode contains all day labels, including week numbers on the left
+ * (marked with the .week-number css class) and day names on top (marked with the
+ * .day-name css class).
*
- * Day labels that belong to the previous or next month get the .other-month style class.
- * The label of the current day get the .today style class.
+ * Day labels that belong to the previous or next month get the .other-month
+ * style class. The label of the current day get the .today style class.
*
* Marked day labels get the :selected state assigned.
*/
* GtkCalendar:year:
*
* The selected year.
+ *
* This property gets initially set to the current year.
*/
g_object_class_install_property (gobject_class,
* GtkCalendar:month:
*
* The selected month (as a number between 0 and 11).
+ *
* This property gets initially set to the current month.
*/
g_object_class_install_property (gobject_class,
/**
* GtkCalendar:day:
*
- * The selected day (as a number between 1 and 31, or 0
- * to unselect the currently selected day).
+ * The selected day (as a number between 1 and 31.
+ *
+ * This can be set to 0 to unselect the currently selected day).
* This property gets initially set to the current day.
*/
g_object_class_install_property (gobject_class,
*
* Creates a new calendar, with the current date being selected.
*
- * Returns: a newly #GtkCalendar widget
- **/
+ * Returns: a newly `GtkCalendar` widget
+ */
GtkWidget*
gtk_calendar_new (void)
{
/**
* gtk_calendar_select_day:
- * @self: a #GtkCalendar.
+ * @self: a `GtkCalendar`.
* @date: (transfer none): a #GDateTime representing the day to select
*
- * Will switch to @date's year and month and select its day.
- **/
+ * Switches to @date's year and month and select its day.
+ */
void
gtk_calendar_select_day (GtkCalendar *calendar,
GDateTime *date)
/**
* gtk_calendar_clear_marks:
- * @calendar: a #GtkCalendar
+ * @calendar: a `GtkCalendar`
*
* Remove all visual markers.
- **/
+ */
void
gtk_calendar_clear_marks (GtkCalendar *calendar)
{
/**
* gtk_calendar_mark_day:
- * @calendar: a #GtkCalendar
+ * @calendar: a `GtkCalendar`
* @day: the day number to mark between 1 and 31.
*
* Places a visual marker on a particular day.
/**
* gtk_calendar_get_day_is_marked:
- * @calendar: a #GtkCalendar
+ * @calendar: a `GtkCalendar`
* @day: the day number between 1 and 31.
*
* Returns if the @day of the @calendar is already marked.
/**
* gtk_calendar_unmark_day:
- * @calendar: a #GtkCalendar.
+ * @calendar: a `GtkCalendar`.
* @day: the day number to unmark between 1 and 31.
*
* Removes the visual marker from a particular day.
/**
* gtk_calendar_get_date:
- * @self: a #GtkCalendar
+ * @self: a `GtkCalendar`
*
* Returns a #GDateTime representing the shown
- * year, month and the selected day, in the local
- * time zone.
+ * year, month and the selected day.
*
- * Returns: (transfer full): the #GDate representing
+ * The returned date is in the local time zone.
+ *
+ * Returns: (transfer full): the `GDate` representing
* the shown date.
*/
GDateTime *
/**
* gtk_calendar_set_show_week_numbers:
- * @self: a #GtkCalendar
+ * @self: a `GtkCalendar`
* @value: whether to show week numbers on the left of the days
*
* Sets whether week numbers are shown in the calendar.
/**
* gtk_calendar_get_show_week_numbers:
- * @self: a #GtkCalendar
+ * @self: a `GtkCalendar`
*
* Returns whether @self is showing week numbers right
- * now, i.e. the value of the #GtkCalendar:show-week-numbers
+ * now.
+ *
+ * This is the value of the [property@Gtk.Calendar:show-week-numbers]
* property.
*
* Return: Whether the calendar is showing week numbers.
/**
* gtk_calendar_set_show_heading:
- * @self: a #GtkCalendar
+ * @self: a `GtkCalendar`
* @value: Whether to show the heading in the calendar
*
- * Sets whether the calendar should show a heading
- * containing the current year and month as well as
+ * Sets whether the calendar should show a heading.
+ *
+ * The heading contains the current year and month as well as
* buttons for changing both.
*/
void
/**
* gtk_calendar_get_show_heading:
- * @self: a #GtkCalendar
+ * @self: a `GtkCalendar`
*
- * Returns whether @self is currently showing the heading,
- * i.e. the value of the #GtkCalendar:show-heading property.
+ * Returns whether @self is currently showing the heading.
+ *
+ * This is the value of the [property@Gtk.Calendar:show-heading]
+ * property.
*
* Return: Whether the calendar is showing a heading.
*/
/**
* gtk_calendar_set_show_day_names:
- * @self: a #GtkCalendar
+ * @self: a `GtkCalendar`
* @value: Whether to show day names above the day numbers
*
* Sets whether the calendar shows day names.
/**
* gtk_calendar_get_show_day_names:
- * @self: a #GtkCalendar
+ * @self: a `GtkCalendar`
*
* Returns whether @self is currently showing the names
- * of the week days above the day numbers, i.e. the value
- * of the #GtkCalendar:show-day-names property.
+ * of the week days.
+ *
+ * This is the value of the [property@Gtk.Calendar:show-day-names]
+ * property.
*
* Returns: Whether the calendar shows day names.
*/
projects / gtk4.git / commitdiff